[FIX] Replaced the latest version tag with a baked-in version #390

rmanaem · 2024-12-04T17:14:04Z

Closes Replace the latest version tag with a baked-in version #291

Changes proposed in this pull request:

The version is now read from the package.json
Docker workflows have been update:
- build docker on release:
  - update the version in package.json to match that of GitHub
  - commits the change of version in package.json
  - trigger the deploy workflow
- build docker nightly:
  - update the version in package.json to the latest SHA
  - don't commit the change in version

Checklist

This section is for the PR reviewer

PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
PR has a label for the release changelog or skip-release (to be applied by maintainers only)
PR links to GitHub issue with mention Closes #XXXX
Tests pass
Checks pass
If the PR changes the participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have been regenerated

For new features:

Tests have been added

For bug fixes:

There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Replace the dynamic fetching of the latest release tag with a static version from package.json and update Docker workflows to manage versioning during builds.

Bug Fixes:

Replace the dynamic fetching of the latest release tag with a static version read from package.json in the Navbar component.

CI:

Update Docker workflows to handle versioning by reading from package.json and committing changes during release builds.

sourcery-ai · 2024-12-04T17:14:09Z

Reviewer's Guide by Sourcery

This PR implements a more reliable versioning system by reading the version from package.json instead of fetching it from GitHub's API. The Docker workflows have been updated to manage this version: the release workflow now updates package.json with the release version and commits the change, while the nightly build workflow updates it with the latest commit SHA without committing.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Changed version management from GitHub API to package.json	Removed GitHub API call to fetch latest release tag Added import of version from package.json Updated version badge to use package.json version	`src/components/Navbar.tsx`
Enhanced release Docker workflow with version management	Added step to extract release version from GitHub event Added GitHub App token generation for authentication Added step to update package.json version Added commit and push of updated package.json Added trigger for deploy workflow	`.github/workflows/build_docker_on_release.yml`
Updated nightly Docker build workflow	Added step to fetch latest commit SHA Added step to update package.json version with SHA Version is updated but not committed	`.github/workflows/build_docker_nightly.yml`
Modified deploy workflow triggers	Removed direct trigger on release publish Added repository dispatch trigger	`.github/workflows/deploy.yaml`

Assessment against linked issues

Issue	Objective	Addressed
#291	Replace the latest version tag fetched from GitHub API with a baked-in version from package.json	✅
#291	Implement correct version handling for release builds (using release version) and nightly builds (using commit SHA)	✅
#291	Ensure version information is baked into Docker image during build process	✅

Possibly linked issues

Replace the latest version tag with a baked-in version #291: The PR implements changes to replace the latest version tag with a baked-in version, addressing the issue.
Replace the latest version tag with a baked-in version #291: The PR implements the issue's request to bake version info into the build, not fetch it.
Replace the latest version tag with a baked-in version #291: PR updates Docker workflows to include nightly builds, addressing the issue's requirement for nightly updates.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time. You can also use
this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

netlify · 2024-12-04T17:14:29Z

✅ Deploy Preview for neurobagel-query ready!

Name	Link
🔨 Latest commit	`4ab3f86`
🔍 Latest deploy log	https://app.netlify.com/sites/neurobagel-query/deploys/6758098bba922e0008c6b0ec
😎 Deploy Preview	https://deploy-preview-390--neurobagel-query.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sourcery-ai

Hey @rmanaem - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 2 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

.github/workflows/build_docker_on_release.yml

surchs

Thanks @rmanaem for this! Looks very nice and solves an important problem 🎉

I left some comments, mainly clarity. But please also open an issue to explore ways to make the package.json version bump part of the release in the future. I think that'd be clearer

🧑‍🍳

.github/workflows/build_docker_nightly.yml

.github/workflows/build_docker_on_release.yml

.github/workflows/deploy.yaml

src/components/Navbar.tsx

rmanaem · 2024-12-05T17:23:44Z

After an in-length discussion, we decided to move to implementing a workflow to run on PR when labels have been changed (action type: labeled, see docs). This workflow will calculate the new version using auto version (see docs), update the package.json.
The application of release label should only happen after the requested changes and comments have been addressed and the PR has been approved to avoid out of sync local and remote.

surchs

Thanks @rmanaem, this looks very good!

Left one question, otherwise 🧑‍🍳

.github/workflows/bump_version.yml

rmanaem added 7 commits December 3, 2024 13:46

Modified build_docker_nightly workflow

9b934c3

Set GH_TOKEN

03fdca8

A different approach

4bcc1d7

Use shortened sha

99b3d63

Updated build_docker_on_release workflow

df384c7

Updated deploy workflow

4653948

Removed fetching version from GitHub

44ab88f

sourcery-ai bot reviewed Dec 4, 2024

View reviewed changes

.github/workflows/build_docker_on_release.yml Outdated Show resolved Hide resolved

.github/workflows/build_docker_on_release.yml Outdated Show resolved Hide resolved

rmanaem added pr-bug-fix Bug fix, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged labels Dec 4, 2024

Fixed typo

b33d5f2

rmanaem requested review from surchs and alyssadai December 4, 2024 17:23

surchs approved these changes Dec 4, 2024

View reviewed changes

rmanaem added 2 commits December 5, 2024 12:36

Reverted changes made to deploy workflow

189ce59

Added bump_version workflow

309a808

rmanaem added pr-bug-fix Bug fix, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged and removed pr-bug-fix Bug fix, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged labels Dec 5, 2024

rmanaem added 2 commits December 5, 2024 12:48

Updated bump_version workflow

4f34aa4

Added the labeled type

d28e9fc

rmanaem added release Create a release when this PR is merged and removed release Create a release when this PR is merged labels Dec 5, 2024

rmanaem and others added 3 commits December 5, 2024 12:54

Test different auto commands

2f09538

Merge branch 'main' into bug-291

dc6b038

comment out the label condition

9c8bdc4

rmanaem and others added 9 commits December 7, 2024 15:05

Let's see what's in there

2ff682c

Let's check this one out

85ed482

This should do it

6123cf6

It's possible we didn't even needed the branch name

ba6aec1

Try this syntax

38d6ce2

Merge 38d6ce2 into 7a40a68

315d64b

Bumped version to v0.7.2

b3cbe19

Added a condition to check diff before commiting

80db23a

Refactor

bceed54

rmanaem removed the release Create a release when this PR is merged label Dec 7, 2024

Added a condition to skip the workflow when increment is empty

8564c74

rmanaem added the release Create a release when this PR is merged label Dec 7, 2024

rmanaem and others added 3 commits December 7, 2024 15:24

Small refactor

6e524ef

Removed the explicit condition and used label condition

700c270

Merge 700c270 into 7a40a68

1c122f6

rmanaem added release Create a release when this PR is merged and removed release Create a release when this PR is merged labels Dec 7, 2024

neurobagel-bot bot and others added 4 commits December 7, 2024 20:27

Bumped version to v0.7.2

b154142

Updated pull_request_template

493b08a

Reverted changes made to build_docker_on_release

cfb0f22

Fixed typo

fa34e38

rmanaem requested review from surchs and alyssadai and removed request for alyssadai December 7, 2024 20:40

surchs approved these changes Dec 9, 2024

View reviewed changes

.github/workflows/bump_version.yml Show resolved Hide resolved

Merge branch 'main' into bug-291

4ab3f86

rmanaem merged commit f3c5210 into main Dec 10, 2024
9 checks passed

rmanaem deleted the bug-291 branch December 10, 2024 09:29

This was referenced Dec 13, 2024

Decouple version tag from the repo #111

Closed

version bumping in a PR creates a git tag with that version, breaking auto #410

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX] Replaced the latest version tag with a baked-in version #390

[FIX] Replaced the latest version tag with a baked-in version #390

rmanaem commented Dec 4, 2024 •

edited

Loading

sourcery-ai bot commented Dec 4, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

netlify bot commented Dec 4, 2024 •

edited

Loading

sourcery-ai bot left a comment

surchs left a comment •

edited

Loading

rmanaem commented Dec 5, 2024

surchs left a comment

[FIX] Replaced the latest version tag with a baked-in version #390

[FIX] Replaced the latest version tag with a baked-in version #390

Conversation

rmanaem commented Dec 4, 2024 • edited Loading

Checklist

Summary by Sourcery

sourcery-ai bot commented Dec 4, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

netlify bot commented Dec 4, 2024 • edited Loading

✅ Deploy Preview for neurobagel-query ready!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

surchs left a comment • edited Loading

Choose a reason for hiding this comment

rmanaem commented Dec 5, 2024

surchs left a comment

Choose a reason for hiding this comment

rmanaem commented Dec 4, 2024 •

edited

Loading

sourcery-ai bot commented Dec 4, 2024 •

edited

Loading

netlify bot commented Dec 4, 2024 •

edited

Loading

surchs left a comment •

edited

Loading